Skip to content

DAFNI Workflow Enhancements #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
May 12, 2025
Merged

DAFNI Workflow Enhancements #299

merged 27 commits into from
May 12, 2025

Conversation

f-allian
Copy link
Contributor

Enhancements to the DAFNI workflow that enables better usability and reproducibility. These include:

  • Removed variables.json as an argument. The variables can now be stored as metadata attributes in the dot file produced by the user.
  • Developing a local test suite to ensure the entrypoint works as expected.
  • Turned main_dafni.py into a module, which improves the modularity and testability of the entrypoint in the test suite.
  • CI/CD workflows have also been updated.

@f-allian f-allian added the enhancement New feature or request label Dec 11, 2024
@f-allian f-allian self-assigned this Dec 11, 2024
@f-allian f-allian marked this pull request as ready for review December 11, 2024 11:30
Copy link

github-actions bot commented Dec 11, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ PYTHON black 31 0 0.96s
✅ PYTHON pylint 31 0 6.07s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.84%. Comparing base (cdbaf1c) to head (40faa83).
Report is 29 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #299   +/-   ##
=======================================
  Coverage   93.84%   93.84%           
=======================================
  Files          27       27           
  Lines        1593     1593           
=======================================
  Hits         1495     1495           
  Misses         98       98           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 38cdc68...40faa83. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@f-allian f-allian marked this pull request as draft February 27, 2025 10:19
@f-allian f-allian marked this pull request as ready for review April 3, 2025 09:59
@f-allian f-allian requested review from jmafoster1 and Copilot April 3, 2025 09:59
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces enhancements to the DAFNI workflow to improve usability and reproducibility. Key changes include:

  • Storing variable metadata directly in the dot file and removing the standalone variables.json argument.
  • Converting main_dafni.py into a module to facilitate local testing.
  • Updating CI/CD workflows and docker-compose configurations for improved build and test processes.

Reviewed Changes

Copilot reviewed 5 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
dafni/model_definition.yaml Updated metadata with additional attributes and a modified URL.
dafni/main_dafni.py Removed the standalone entry point to favor modular testing.
dafni/docker-compose.yaml Adjusted the Dockerfile path and volume mount changes.
dafni/README.md Revised directory hierarchy documentation to reflect changes.
.github/workflows/publish-to-dafni.yaml Added dependency installation and test execution steps prior to container build.
Files not reviewed (5)
  • dafni/Dockerfile: Language not supported
  • dafni/data/inputs/causal_tests.json: Language not supported
  • dafni/data/inputs/dag.dot: Language not supported
  • dafni/data/inputs/variables.json: Language not supported
  • dafni/data/outputs/causal_tests_results.json: Language not supported
Comments suppressed due to low confidence (1)

dafni/model_definition.yaml:2

  • The updated URL now includes a percent-encoded space. Please verify that this is the intended URL and that it resolves correctly.
+# https://docs.secure.dafni.rl.ac.uk/docs/How%20to/how-to-write-a-model-definition-file

@f-allian f-allian requested a review from jmafoster1 May 1, 2025 08:33
@f-allian f-allian merged commit 15513be into main May 12, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants